Fetch Action details

Fetches comprehensive information about Actions within your project. This endpoint supports:

Pagination: Control response size with configurable page numbers and sizes (max 25 items per page)
Flexible Filtering: Filter by specific Action IDs
Optional Detailed Information: Selectively include Action Custom fields
User-Specific Version View: Results reflect the requesting user’s current version of the entities.

POST{accelqLoginUrl}/awb/api/2.0/{tenantCode}/{projectCode}/ctx/actions/fetch-details

Headers

Header	Value
`user_id`	Login username (email)
`api_key`	API key of the user for authentication
`Content-Type`	application/json
`Accept`	application/json

Parameters

Parameter	Type	Required	Description
`accelqLoginUrl`	string	Yes	The AccelQ login URL for API access.
`tenantCode`	string	Yes	Tenant code for identifying the organization.
`projectCode`	string	Yes	Project Code found under Auth properties of ACCELQ User Profile.
`pageNumber`	integer	No	Page number for pagination.
`pageSize`	integer	No	Number of Actions to return per page (Max 25).
`user_id`	string	Yes	Login username (email)
`api_key`	string	Yes	API key of the user for authentication

Request Body

json

{
  "filter": {
    "actionIds": [
      463,
      1134
    ]
  },
  "additionalDetails": {
    "customFields": true
  }
}

Responses

200 - Successful retrieval of Action details.

json

{
  "page": 1,
  "pageSize": 10,
  "totalPages": 1,
  "totalCount": 1,
  "results": [
    {
      "id": 463,
      "name": "Login Action",
      "description": "string",
      "status": "Work In Progress",
      "createdBy": "Tenant Admin",
      "createdTimestamp": "2026-02-20T02:47:01Z",
      "lastModifiedBy": "Tenant Admin",
      "lastModifiedTimestamp": "2026-02-20T02:50:40Z",
      "tags": [
        "Smoke",
        "Sanity"
      ],
      "customFields": {
        "Priority": "High",
        "Reviewers": [
          "Stephan"
        ]
      }
    }
  ]
}

401 - Unauthorized - Invalid authentication credentials

json

{
  "error": "Invalid user credentials or API key"
}

403 - Forbidden

json

{
  "error": "User does not have authorization to access this feature"
}

500 - Internal Server Error

json

{
  "error": "Error occurred while retrieving Action details"
}

cURL Command Builder

URL Parameters

accelqLoginUrl (string) *

tenantCode (string) *

projectCode (string) *

pageNumber (integer)

pageSize (integer)

Headers

user_id (string) *

api_key (string) *

Request Sample (cURL)

curl -X POST "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/${{projectCode}}/ctx/actions/fetch-details?pageNumber=${{pageNumber}}&pageSize=${{pageSize}}" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "filter": {
    "actionIds": [
      463,
      1134
    ]
  },
  "additionalDetails": {
    "customFields": true
  }
}'